Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(github): add conventional commits check #11972

Closed
wants to merge 2 commits into from
Closed

chore(github): add conventional commits check #11972

wants to merge 2 commits into from

Conversation

nowNick
Copy link
Contributor

@nowNick nowNick commented Nov 9, 2023

Summary

This commit adds action-conventional-commits gh action

Checklist

  • N/A The Pull Request has tests
  • N/A A changelog file has been created under changelog/unreleased/kong or skip-changelog label added on PR if changelog is unnecessary. README.md
  • N/A There is a user-facing docs PR against https://github.com/Kong/docs.konghq.com - PUT DOCS PR HERE

Full changelog

N/A

Issue reference

KAG-1290

@nowNick
chore(github): add conventional commits check
b71598c 
This commit adds action-conventional-commits gh action

KAG-1290
@github-actions github-actions bot added the chore Not part of the core functionality of kong, but still needed label Nov 9, 2023
dndx
dndx requested changes Nov 13, 2023
View reviewed changes
Copy link
Member

@dndx dndx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work with our current flow. We do not enforce conventional commits at PR level, but enforces master commits to be conventional commits. The only way to do this is via squash and merge, not another GitHub Check.

@nowNick
Copy link
Contributor Author

nowNick commented Nov 13, 2023

Oh! Thanks @dndx for pointing that out!

Let me make sure I understood you correctly. What we care about is following Conventional Commits standards on master branch. However when you Squash & Merge a PR, there's a new commit created, so it does not really matter whether the PR followed CC standards or not, because all of those commits will become the new commit?

We could try to consider enforcing PR title standards, because from what I can see GH uses PR title as a placeholder for the Squash&Merge commit message. However since it's still can be edited by a user, I don't think it makes sense to enforce it like that anyway.

So I guess we should just drop this PR and update the ticket with proper message.

Does it sound ok? 👍 / 👎 ?

@nowNick nowNick closed this Feb 19, 2024
@nowNick nowNick deleted the feat/add-conv-commits-gh-action branch February 19, 2024 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dndx dndx dndx requested changes

Assignees

@nowNick nowNick

Labels
chore Not part of the core functionality of kong, but still needed size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nowNick @dndx @hanshuebner